Add aod and clearsky_index to glossary, link terms in spectrum.rst#2663
Add aod and clearsky_index to glossary, link terms in spectrum.rst#2663RDaxini wants to merge 14 commits intopvlib:mainfrom
aod and clearsky_index to glossary, link terms in spectrum.rst#2663Conversation
echedey-ls
left a comment
echedey-ls
left a comment
There was a problem hiding this comment.
Sexy PR @RDaxini , thanks. Some observations down below, but I'm okay with current status as is.
| aod | ||
| aod500 | ||
| aerosol optical depth. Measure of aerosols (e.g., smoke | ||
| particles, desert dust) distributed within a column of air from the | ||
| instrument (Earth's surface) to the top of the atmosphere. The AOD | ||
| value indicates the level of extinction of sunlight in this column, and | ||
| when followed by a number (e.g. AOD500), indicates the extinction at | ||
| this wavelength (500nm). [unitless] | ||
|
|
There was a problem hiding this comment.
Is it described by these equations? https://en.wikipedia.org/wiki/Optical_depth#Spectral_optical_depth
I have trouble finding PV specific information on a mathematical relationship. At least that is the only missing piece for me.
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
…ib-python into glossary_definitions
|
@cwhanse could you try rerunning the docs build? |
There was a problem hiding this comment.
| * Add the following terms to the :ref:`nomenclature` page: | |
| - :term:`clearness_index` | |
| - :term:`clearsky_index` | |
| - :term:`aod` | |
| - :term:`aod500` | |
| (:issue:`2564`, :pull:`2663`) | |
| * Add the following terms to the :ref:`nomenclature` page (:issue:`2564`, :pull:`2663`): | |
| - :term:`clearness_index` | |
| - :term:`clearsky_index` | |
| - :term:`aod` | |
| - :term:`aod500` |
I think it's getting hung up because it's looking for a blank line at the end of a bulleted list.
There was a problem hiding this comment.
I don't know how to restart the doc build without some new commit.
There was a problem hiding this comment.
I think a new commit is needed thou:
| * Add the following terms to the :ref:`nomenclature` page: | |
| - :term:`clearness_index` | |
| - :term:`clearsky_index` | |
| - :term:`aod` | |
| - :term:`aod500` | |
| (:issue:`2564`, :pull:`2663`) | |
| * Add the following terms to the :ref:`nomenclature` page: (:issue:`2564`, :pull:`2663`) | |
| - :term:`clearness_index` | |
| - :term:`clearsky_index` | |
| - :term:`aod` | |
| - :term:`aod500` | |
À la https://github.com/pvlib/pvlib-python/blob/bba49c0c477bdb442bf889f071a7a86d03d1766e/docs/sphinx/source/whatsnew/v0.13.0.rst?plain=1#L24C1-L34C1, I found this pattern to be the most common in the latest releases.
There was a problem hiding this comment.
That looks kinda weird IMO 😂 but not a huge deal. I've pushed the commit, thanks.
There was a problem hiding this comment.
That looks kinda weird IMO
@RDaxini you mean the issues and pr roles after the colon? I feel the same, but IDK how to improve that.
There was a problem hiding this comment.
Yes, after the colon is weird. It interferes with the grammatical structure of the following list.
We also usually add the pr/issue link after the full whatsnew entry, and the listed items are part of that entry, so that's why I added the pr/issue links after the list.
There was a problem hiding this comment.
Put the colon after the (issue, pr) text
Co-authored-by: Echedey Luis <80125792+echedey-ls@users.noreply.github.com>
4 participants
aodandclearsky_indexto glossary #2564docs/sphinx/source/whatsnewfor all changes. Includes link to the GitHub Issue with:issue:`num`or this Pull Request with:pull:`num`. Includes contributor name and/or GitHub username (link with:ghuser:`user`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.Additional edit: fixed line length of some of the other definitions. Not strictly a flake8 failure but I think it looks neater and more readable.